package com.gzy.rpsm_admin.config;

import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @ApiImplicitParams({
            @ApiImplicitParam(name="number", value="楼栋编号", dataType = "String", paramType = "query")
    })
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.OAS_30)
// DocumentationType.OAS_30 固定的，代表 swagger3
                //.groupName("分布式任务系统")
                // 如果配置多个文档的时候，那么需要配置 groupName 来分组标识
                .apiInfo(apiInfo()) // 用于生成 API 信息
                .select() // select()函数返回一个
//        ApiSelectorBuilder 实例,用来控制接口被 swagger 做成文档
                .apis(RequestHandlerSelectors.basePackage("com.gzy.rpsm_admin.controller"))
                // 用于指定扫描哪个包下的接口
                .paths(PathSelectors.any())
                // 选择所有的 API,如果你想只为部分 API 生成文档，可以配置这里
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("物业管理项目管理员系统")// 可以用来自定义 API 的主标题
                .description("进行基础资料的管理") // 可以用来描述整体的 API
                .termsOfServiceUrl("") // 用于定义服务的域名
                .version("1.0") // 可以用来定义版本。
                .build(); //
    }
}



